IApi.EnableProfilePosition method

Adds the Profile Velocity, Profile Acceleration, and Profile Deceleration variables to PDO.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError EnableProfilePosition(
       bool Active
)

Function EnableProfilePosition(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

true: The Profile Velocity, Profile Acceleration, and Profile Deceleration variables are mapped to PDO. false: Not mapped to PDO. By default, it is false.

Return value

Type: KsError

A return code of a method.

Remarks

This method must be called after Create and before Start.

Usable EtherCAT states

ecatOffline

Examples

N/A